This program is dedicated to Quinn “The Eskimo” for all the help he has given to people all around the world, and especially for the help and friendship he has given me!
StreamWatcher allows you to examine the data transmitted through Open Transport TCP streams. This is useful for debugging network applications and network problems.
Features
• StreamWatcher can examine all OpenTransport TCP streams (using “OT AutoPush Support” from Quinn), allowing you to examine networking traffic for any application on your computer.
• StreamWatcher can display multiple streams simultaneously, either in a single window, or one stream in each window. This allows you to watch sessions where many different connections are made (such as a web browser downloading a page with pictures).
• StreamWatcher can display the stream data in text or binary mode (automatically or manually).
StreamWatcher requires a PowerPC (Power Macintosh or clone) and Open Transport.
Contents
• Using StreamWatcher
• General Intercept
• Specific Intercept
• Display Options
• Limitations
• Registering
• On-Line Registration
• Off-Line Registration
• Site Licensing
• Warranty
• Fine Print
• Acknowledgements
Using StreamWatcher
StreamWatcher works by intercepting a TCP stream in Open Transport and dumping this information to the screen and to a file. If you want to check on any OT TCP application’s stream, you can use the General Intercept method, which uses OT’s AutoPush method to intercept any application using TCP.
If you are developing an application you can use the Specific Intercept method, which causes StreamWatcher to intercept only that application.
General Intercept
This method intercepts every Open Transport TCP session. You must run StreamWatcher before the TCP session is established.
• Drop “StreamWatcher Module” and “OT AutoPush Support” into the extensions folder.
• Restart.
• When you want to watch a stream, launch StreamWatcher.
Note: You must launch StreamWatcher before the TCP connection is established.
Each TCP connection that is established after you launch StreamWatcher will cause a window to open displaying the data sent and received through that stream.
Specific Intercept
This method intercepts only applications which call StreamWatcher (its easy!). You can run StreamWatcher after the TCP session is established.
• Drop “StreamWatcher Module” into the extensions folder.
• When you want to watch a stream, instead of creating a TCP configuration using “OTCreateConfiguration("tcp")”, use:
OTCreateConfiguration("StreamWatcher,tcp").
• Launch StreamWatcher and your application. StreamWatcher will display each TCP connection you create using the configuration above in a new window.
Note: You can launch StreamWatcher after the TCP connection is established if you use this special configuration method.
Display Options
You can control the display format of the data by selecting Text, Binary or Automatic from the Edit menu, as well as by selecting Show Spaces (for Text mode).
Note: The contents of the window will not change when you change the formatting options, only new data will use the formatting options you select.
You can save the contents of the window to a file using the Save As command in the File Menu.
Other Notes
StreamWatcher works so long as data is sent into the TCP/IP stack. For instance when looking at a local Web Server StreamWatcher will pick up two streams: one coming out from the WebServer and another coming in to the web browser.
StreamWatcher will not display a failed connection or a connection that never sends or receives any TCP data (eg Open and then close).
If StreamWatcher is not active, the Quinn’s OT Autopush Support extension will not incur any CPU overhead, so it is OK to leave it installed at all times. Also, if you switch of ‘Watch All’ in the File menu (cmd-K), StreamWatcher will not incur any overhead on new Streams. (The only overhead is in displaying and storing the text.)
Limitations
StreamWatcher requires a PowerPC (Power Macintosh or clone) and Open Transport.
Registering
This program is Shareware, which means if you use it, you must pay for it. A single user license costs US$35. Registration will remove the registration reminder screen when StreamWatcher is started up.
You can pay in one of two ways: on-line registration using a web browser, or off-line registration using the Register program. As soon as Kagi Shareware has processed your registration they will send you an 18 digit registration code. This registration code must be entered into StreamWatcher. Note that this code is keyed to your name, so make sure you enter the same name into StreamWatcher that you used to Register. (The name will be included in the Registration Acknowledgement from Kagi.)
To enter the Registration code, open StreamWatcher and select Enter Serial Number... from the File menu. This will open the Register window, where you can enter your name and the Registration number. Thanks for Registering!
On-Line Registration
Our online registration can be found at:
<http://order.kagi.com/cgi-bin/register1.cgi?PL>
Off-Line Registration
Or, using the Register program, you need to:
1. Get hold of a copy of the Register program: Register comes with the StreamWatcher distribution. You can also get Register from the following sites:
<ftp://ftp.stairways.com/stairways/>
<ftp://mirrors.aol.com/pub/peterlewis/>
<ftp://ftp.amug.org/pub/peterlewis/>
..or there are download links on the following Web page:
<http://www.stairways.com/register/topay.html>
2. Run the Register program and fill out the form: You need to enter your name, email, postal address, and the shareware you wish to pay for. The form accepts many different payment methods such as: US Check, Money Order, Cash (in many different currencies), Visa, Mastercard, American Express, First Virtual, and Invoice (to be given to your accounts payable department).
3. Send it to Kagi Shareware: Then either email the data generated by the registration program or print it and send it via postal mail or fax. Credit card information is encoded by the Register program.
The address to send the completed form is output by Register when you Print or Copy the completed form. The addresses are:
Email: shareware@kagi.com
FAX: +1 510 652 6589
Snail-mail:
Kagi Shareware
1442-A Walnut Street #392-PL
Berkeley, California, 94709-1405
USA
4. Enter the Registration Code: When you receive a reply from Kagi Shareware, enter the Registration code into StreamWatcher. This process is described above.
You may distribute this program any way you wish as long as you don’t charge for it (reasonable download costs are OK). You must distribute the package in its entirety. We don’t guarantee any support, but we always answer our Email. If we don’t answer Email it is because your message didn’t get to us, or our reply bounced, so please try again and include a valid Internet address if you can.
You MAY NOT DISTRIBUTE this program on any disk or CD without our explicit permission. (Please E-Mail us.)
Site Licensing
World-wide license: US$2000
Universities or companies site license: US$500
A site license covers usage of StreamWatcher on an unlimited number of machines within 100 miles of some arbitrary central point which are owned by the licensed organization.
World Wide licenses remove the 100 mile radius restriction.
Warranty
This program should do what is described in this document. If it doesn’t, you can simply stop using it. If you paid for the product, and within a year find that it doesn’t do what has been described here, then you can notify Stairways Shareware and your money will be refunded and your license cancelled.
Fine Print
Peter Lewis hereby disclaims all warranties relating to this software, whether express or implied, including without limitation any implied warranties of merchantability or fitness for a particular purpose. Peter Lewis will not be liable for any special, incidental, consequential, indirect or similar damages due to loss of data or any other reason, even if Peter Lewis or an agent of his has been advised of the possibility of such damages. In no event shall Peter Lewis be liable for any damages, regardless of the form of the claim. The person using the software bears all risk as to the quality and performance of the software.
US Government
Government End Users: If you are acquiring the Software and fonts on behalf of any unit or agency of the United States Government, the following provisions apply. The Government agrees:
(i) if the Software and fonts are supplied to the Department of Defence (DoD), the Software and fonts are classified as "Commercial Computer Software" and the Government is acquiring only "restricted rights" in the Software, its documentation and fonts as that term is defined in Clause 252.227-7013(c)(1) of the DFARS; and
(ii) if the Software and fonts are supplied to any unit or agency of the United States Government other than DoD, the Government's rights in the Software, its documentation and fonts will be as defined in Clause 52.227-19(c)(2) of the FAR or, in the case of NASA, in Clause 18-52.227-86(d) of the NASA Supplement to the FAR.
Acknowledgements
Thanks to Quinn “The Eskimo” for his help with this program (which would never have been written otherwise), for writing the “OT AutoPush Support” extension, and of course for his friendship over many years.
